home *** CD-ROM | disk | FTP | other *** search
/ Your Choice 3 / Your Choice Software Collection 3.iso / prgmming / bansi111 / manual.txt < prev    next >
Encoding:
Text File  |  1994-08-31  |  6.9 KB  |  215 lines
  1. ░░░    ▒▒▒    ▓▓▓        █▀▀▀▀▄                       TM
  2.   ░░░    ▒▒▒    ▓▓▓      █    █                    ▄
  3.     ░░░    ▒▒▒    ▓▓▓    █    █  ▄▄▄   ▄▄▄▄   ▄▄   ▄
  4.       ░░░    ▒▒▒    ▓▓▓  █▀▀▀▀▄ █   █  █   █ █  ▀  █
  5.     ░░░    ▒▒▒    ▓▓▓    █    █ █   █  █   █  ▀▀▄  █
  6.   ░░░    ▒▒▒    ▓▓▓      █▄▄▄▄▀ ▀▄▄▄▀▄ █   █ ▀▄▄▀  █
  7. ░░░    ▒▒▒    ▓▓▓
  8.                          The BASIC ANSI Library v1.11
  9.  
  10.            █▄ ▄█ ▄▀▀▄ █▄   █ █  █ ▄▀▀▄ █
  11.            █ ▀ █ █▄▄█ █ ▀▄ █ █  █ █▄▄█ █
  12.            █   █ █  █ █   ▀█ ▀▄▄▀ █  █ █▄▄▄
  13.                                                                
  14.  
  15. Designed and programmed by Chris Walker.
  16.  
  17.  
  18. This document and all files included within the Bansi package are
  19.         (c) Copyright 1994 by Chris Walker
  20.                 ALL RIGHTS RESERVED
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69. -------------------------------------------------------------------------------
  70. Bansi Library v1.11 short manual          (c) Copyright 1994 by Chris Walker
  71.                                                   ALL RIGHTS RESERVED
  72. -------------------------------------------------------------------------------
  73. Explanation:  This manual briefly summarizes the usage of each of the Bansi
  74.         commands.
  75. -------------------------------------------------------------------------------
  76.         Starting up the Bansi functions:
  77.  
  78.         To load the Bansi library with QuickBasic, the command line is:
  79.  
  80.         QB /lbansi <program to load>
  81.  
  82.         Other languages are similar.
  83.  
  84.         Inside the interpreter, you must include:
  85.  
  86.         '$include:'bansi.bi'
  87.  
  88.         into your file.  After that, you may go on into installation.
  89.  
  90.         When you want to run a Bansi function, you must first (only once in
  91. a program) execute the BAInit command.
  92.  
  93.         As of v1.1 of the Bansi library, the BAInit command is simply:
  94.  
  95. BAInit
  96.  
  97.         (No parameters)
  98.  
  99.         Bansi Standard Commands - Work With The MS-DOS ANSI.SYS Driver.
  100.                                   (TESTED WITH)
  101.  
  102.         ---------------------------
  103.         The Bansi Standard Commands
  104.         ---------------------------
  105.  
  106. BAInit - Initialization sub, used to start routines.
  107.  
  108. BABack$ Function - Returns the < Back string (0-79):
  109.         To Use this function, just use the command
  110.          PRINT #1,BABack$(1)
  111.         This would send the code for 1 back space to whatever was opened as
  112.         #1.  If you had #1 as the comm port, you would use this.  If you
  113.         just wanted to store it to a variable, you could use something like
  114.         this:
  115.          MyVar$=BABack$(20)
  116.         which would store the ANSI code for 20 back spaces in the variable
  117.         string MyVar$.
  118.  
  119. BAClearScreen$ Function - Returns the Screen Clearing String.
  120.         To Use this function, just use the command
  121.          PRINT #1,BAClearScreen$
  122.         This would send the code for a CLS to whatever was opened as #1
  123.  
  124. BAColor$ Function - Returns the Color String (0-31,0-7)
  125.         To Use this function, just use the command
  126.          PRINT #1,BAColor$(10,2)
  127.         This would send the code for a COLOR 10,2 to whatever was opened as
  128.         #1.  Valid numbers are (0-31 foreground,0 to 7 background).  Any other
  129.         parameters result in a white-on-black setting.
  130.  
  131. BAColorString$ Function - Returns a String in Color!
  132.         To Use this function, just use the command
  133.          PRINT #1,BAColorString$("This is in color!","BlackBack")
  134.         This would send the string "This is in color!" to whatever was opened
  135.         as #1.  The text you enter does not matter, and the only limitation on
  136.         length is the length you can fit on one line of your program.  At the
  137.         present time, the only options are "" (nothing - color on color) or
  138.         "BlackBack" (color on black).  The color string can be somewhat hard
  139.         to read if the "BlackBack" option is not used.
  140.  
  141. BADetect$ Function - Returns the ANSI detection string
  142.         To Use this function, just use the command
  143.          PRINT #1,BADetect$
  144.         This would send the code for ANSI detect to whatever was opened as
  145.         #1.  The ANSI return code from this would be something like:
  146.          (ESC)[12;1R
  147.         where 12 is the line and 1 is the column.
  148.  
  149. BADown$ Function - Returns the v Down string (0-24).
  150.         To Use this function, just use the command
  151.          PRINT #1,BADown$(1)
  152.         This would send the code for 1 line down to whatever was opened as
  153.         #1.
  154.  
  155. BAEraseLine$ Function - Returns the Line Clearing String.
  156.         To Use this function, just use the command
  157.          PRINT #1,BAEraseLine$
  158.         This would send the code to erase the current line to whatever was
  159.         opened as #1
  160.  
  161. BAForward$ Function - Returns the > Forward string (0-79).
  162.         To Use this function, just use the command
  163.          PRINT #1,BAForward$(1)
  164.         This would send the code for 1 forward space to whatever was opened as
  165.         #1.
  166.  
  167. BAMove$ Function - Returns the (Absolute Location) string (0-25,0-80).
  168.         To Use this function, just use the command
  169.          PRINT #1,BAMove$(10,5)
  170.         This would send the code to set the cursor at line 10, column 5.
  171.  
  172. BAResPos$ Function - Returns the Restore Cursor Position string.
  173.         To Use this function, just use the command
  174.          PRINT #1,BAResPos$
  175.         This would send the code to restore the saved position to whatever was
  176.         opened as #1
  177.  
  178. BASavPos$ Function - Returns the Save Cursor Position string.
  179.         To Use this function, just use the command
  180.          PRINT #1,BASavPos$
  181.         This would send the code to save the current position to whatever was
  182.         opened as #1
  183.  
  184. BASetMode$ Function - Returns the Set Video Mode string.
  185.         To Use this function, just use the command
  186.          PRINT #1,BASetMode$(0)
  187.         This would send the code to set the video mode to whatever was opened
  188.         as #1.
  189.         The mode numbers are as follows:
  190.  
  191.         0 = 40 x 25 black and white - composite monitors.
  192.         1 = 40 x 25 color.
  193.         2 = 80 x 25 black and white - composite monitors.
  194.         3 = 80 x 25 color.
  195.         4 = 320 x 200 color.
  196.         5 = 320 x 200 black and white - composite monitors.
  197.         6 = 640 x 200 black and white.
  198.         7 = Wrap at end of line.
  199.  
  200. BAUp$ Function - Returns the ^ UP string (0-24).
  201.         To Use this function, just use the command
  202.          PRINT #1,BAUp$(1)
  203.         This would send the code for 1 line up to whatever was opened as
  204.         #1.
  205.  
  206. *NOTE:  There are other commands included in this version of Bansi.  Check the
  207. WHATS.NEW text file for information on those.
  208. --------------
  209.         I realize that this manual is somewhat fuzzy.  In this new version of
  210. the Bansi library, I have added a number of functions.  
  211.         If anyone has more ANSI codes that they know of, please let me know.
  212. I might even be able to send you a free update version!
  213. --------------
  214. End of manual!
  215.